printer 2.2.1
Loading...
Searching...
No Matches
printer.h File Reference

This file contains API for Printer Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  printer_t
 Printer Click context object. More...
struct  printer_cfg_t
 Printer Click configuration object. More...

Macros

#define PRINTER_CMD_EOT   0x04
 Printer control commands.
#define PRINTER_CMD_ENQ   0x05
#define PRINTER_CMD_HT   0x09
#define PRINTER_CMD_LF   0x0A
#define PRINTER_CMD_CR   0x0D
#define PRINTER_CMD_DLE   0x10
#define PRINTER_CMD_DC4   0x14
#define PRINTER_CMD_ESC   0x1B
#define PRINTER_CMD_FS   0x1C
#define PRINTER_CMD_GS   0x1D
#define PRINTER_COM_BAUD_RATE_9600   0x00
 Printer communication mode settings.
#define PRINTER_COM_BAUD_RATE_19200   0x01
#define PRINTER_COM_BAUD_RATE_38400   0x02
#define PRINTER_COM_BAUD_RATE_57600   0x03
#define PRINTER_COM_BAUD_RATE_115200   0x04
#define PRINTER_COM_FLOW_CTRL_OFF   0x00
#define PRINTER_COM_FLOW_CTRL_SW   0x01
#define PRINTER_COM_FLOW_CTRL_HW   0x02
#define PRINTER_HEAD_MM58_FTP628MCL101   0x00
 Printer printer head settings.
#define PRINTER_HEAD_MM80_FTP638MCL101   0x01
#define PRINTER_HEAD_MM58_LTP02_245_13   0x02
#define PRINTER_HEAD_MM58_LTP02_245_C1   0x03
#define PRINTER_FONT_TYPE_NORMAL   0x00
 Printer font type settings.
#define PRINTER_FONT_TYPE_ITALIC   0x02
#define PRINTER_FONT_TYPE_BOLD   0x08
#define PRINTER_FONT_TYPE_DOUBLE_HEIGHT   0x10
#define PRINTER_FONT_TYPE_DOUBLE_WIDTH   0x20
#define PRINTER_FONT_TYPE_REVERSE   0x40
#define PRINTER_FONT_TYPE_UNDERLINE   0x80
#define PRINTER_FONT_SIZE_SMALL   0x01
 Printer font size settings.
#define PRINTER_FONT_SIZE_LARGE   0x02
#define PRINTER_ALIGN_LEFT   0x00
 Printer horizontal align settings.
#define PRINTER_ALIGN_CENTER   0x01
#define PRINTER_ALIGN_RIGHT   0x02
#define PRINTER_GRAYSCALE_0   0x00
 Printer grayscale settings.
#define PRINTER_GRAYSCALE_1   0x01
#define PRINTER_GRAYSCALE_2   0x02
#define PRINTER_GRAYSCALE_3   0x03
#define PRINTER_GRAYSCALE_4   0x04
#define PRINTER_GRAYSCALE_5   0x05
#define PRINTER_GRAYSCALE_6   0x06
#define PRINTER_GRAYSCALE_7   0x07
#define PRINTER_GRAYSCALE_8   0x08
#define PRINTER_PICTURE_TYPE_NORMAL   0x00
 Printer picture settings.
#define PRINTER_BARCODE_SYS_UPCA   0x00
 Printer barcode settings.
#define PRINTER_BARCODE_SYS_UPCE   0x01
#define PRINTER_BARCODE_SYS_EAN13   0x02
#define PRINTER_BARCODE_SYS_EAN8   0x03
#define PRINTER_BARCODE_SYS_CODE39   0x04
#define PRINTER_BARCODE_SYS_ITF25   0x05
#define PRINTER_BARCODE_SYS_CODABAR   0x06
#define PRINTER_BARCODE_SYS_CODE93   0x07
#define PRINTER_BARCODE_SYS_CODE128   0x08
#define PRINTER_CB_STATE_DEFAULT   0x00
 Printer printer callback settings.
#define PRINTER_CB_STATE_PAPEROUT   0x04
#define PRINTER_CB_STATE_OVERHEAT   0x08
#define PRINTER_BITMAP_LOCATION_1   0x01
 Printer bitmap settings.
#define PRINTER_BITMAP_LOCATION_2   0x02
#define PRINTER_BITMAP_LOCATION_3   0x03
#define PRINTER_BITMAP_LOCATION_4   0x04
#define PRINTER_BITMAP_ALIGN   0x00
#define PRINTER_BITMAP_MODE_NORMAL   0x00
#define PRINTER_QR_SIZE_21_53   0x00
 Printer QR code settings.
#define PRINTER_QR_SIZE_57_121   0x01
#define PRINTER_QR_SIZE_125_177   0x02
#define PRINTER_QR_ERROR_7_PCT   0x00
#define PRINTER_QR_ERROR_15_PCT   0x01
#define PRINTER_QR_ERROR_25_PCT   0x02
#define PRINTER_QR_ERROR_30_PCT   0x03
#define PRINTER_READY_TIMEOUT   5000
 Printer device ready timeout.
#define PRINTER_TX_DRV_BUFFER_SIZE   500
 Printer driver buffer size.
#define PRINTER_RX_DRV_BUFFER_SIZE   100
#define PRINTER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  printer_return_value_t { PRINTER_OK = 0 , PRINTER_ERROR = -1 }
 Printer Click return value data. More...

Functions

void printer_cfg_setup (printer_cfg_t *cfg)
 Printer configuration object setup function.
err_t printer_init (printer_t *ctx, printer_cfg_t *cfg)
 Printer initialization function.
err_t printer_default_cfg (printer_t *ctx)
 Printer default configuration function.
err_t printer_generic_write (printer_t *ctx, uint8_t *data_in, uint32_t len)
 Printer data writing function.
err_t printer_generic_read (printer_t *ctx, uint8_t *data_out, uint8_t len)
 Printer data reading function.
uint8_t printer_get_rts_pin (printer_t *ctx)
 Printer get RTS pin function.
err_t printer_get_status (printer_t *ctx)
 Printer get status function.
err_t printer_get_fw_info (printer_t *ctx)
 Printer get FW info function.
err_t printer_set_com_mode (printer_t *ctx, uint8_t baud_rate, uint8_t flow_control)
 Printer set com mode function.
err_t printer_set_printer_head (printer_t *ctx, uint8_t head_index)
 Printer set printer head function.
err_t printer_soft_init (printer_t *ctx)
 Printer soft init function.
err_t printer_print_lf (printer_t *ctx)
 Printer print LF function.
err_t printer_print_cr (printer_t *ctx)
 Printer print CR function.
err_t printer_print_string (printer_t *ctx, char *data_in)
 Printer print string function.
err_t printer_print_string_lf (printer_t *ctx, char *data_in)
 Printer print string function.
err_t printer_print_dots (printer_t *ctx, uint8_t num_dots)
 Printer print dots function.
err_t printer_print_lines (printer_t *ctx, uint8_t num_lines)
 Printer print lines function.
err_t printer_set_font_type (printer_t *ctx, uint8_t font_type)
 Printer set font type function.
err_t printer_set_alignment (printer_t *ctx, uint8_t align)
 Printer set alignment function.
err_t printer_set_line_spacing (printer_t *ctx, uint8_t num_dots)
 Printer set line spacing function.
err_t printer_default_line_spacing (printer_t *ctx)
 Printer default line spacing function.
err_t printer_set_horizontal_tab (printer_t *ctx, uint8_t *col_pos, uint8_t num_tabs)
 Printer set horizontal tab function.
err_t printer_horizontal_tab (printer_t *ctx)
 Printer horizontal tab function.
err_t printer_print_picture (printer_t *ctx, uint8_t *pic_buf, uint16_t h_size, uint16_t v_size)
 Printer print picture function.
err_t printer_set_left_margin (printer_t *ctx, uint8_t num_dots)
 Printer set left margin function.
err_t printer_set_right_margin (printer_t *ctx, uint8_t num_dots)
 Printer set right margin function.
err_t printer_set_abs_print_pos (printer_t *ctx, uint16_t num_dots)
 Printer set abs print pos function.
err_t printer_set_font_grayscale (printer_t *ctx, uint8_t grayscale)
 Printer set font grayscale function.
err_t printer_set_db_mode (printer_t *ctx)
 Printer set db mode function.
err_t printer_cancel_db_mode (printer_t *ctx)
 Printer cancel db mode function.
err_t printer_set_font_size (printer_t *ctx, uint8_t size)
 Printer set font size function.
err_t printer_hide_barcode_text (printer_t *ctx)
 Printer hide barcode text function.
err_t printer_show_barcode_text (printer_t *ctx)
 Printer show barcode text function.
err_t printer_set_barcode_height (printer_t *ctx, uint8_t height)
 Printer set barcode height function.
err_t printer_set_barcode_width (printer_t *ctx, uint8_t width)
 Printer set barcode width function.
err_t printer_print_barcode (printer_t *ctx, uint8_t barcode_sys, uint8_t *barcode, uint8_t barcode_len)
 Printer print barcode function.
err_t printer_clear_print_buffer (printer_t *ctx)
 Printer clear print buffer function.
err_t printer_set_printer_cb (printer_t *ctx, uint8_t callback)
 Printer set printer cb function.
err_t printer_download_nv_bitmap (printer_t *ctx, uint8_t location, uint8_t h_size, uint8_t v_size, uint8_t *bitmap)
 Printer download NV Bitmap function.
err_t printer_print_nv_bitmap (printer_t *ctx, uint8_t location)
 Printer print NV Bitmap function.
err_t printer_set_qr_size (printer_t *ctx, uint8_t size)
 Printer set QR size function.
err_t printer_set_qr_error_corr (printer_t *ctx, uint8_t corr_level)
 Printer set QR error corr function.
err_t printer_transfer_qr_code (printer_t *ctx, uint8_t *qr_code, uint16_t code_len)
 Printer transfer QR code function.
err_t printer_print_qr_code (printer_t *ctx)
 Printer print QR code function.

Detailed Description

This file contains API for Printer Click Driver.

Enumeration Type Documentation

◆ printer_return_value_t

Printer Click return value data.

Predefined enum values for driver return values.

Enumerator
PRINTER_OK 
PRINTER_ERROR